<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs For Class Query</title>
			<link rel="stylesheet" href="../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="class-name">Interface Query</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
															<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
					</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">A <a href="../phpContentRepository/Query.html">Query</a> object.</p>
	<ul class="tags">
				<li><span class="field">copyright:</span> Copyright &amp;copy; 2004-2005, Domain51</li>
				<li><span class="field">author:</span> PHP - Travis Swicegood &lt;<a href="mailto:travis@domain51.net">travis@domain51.net</a>&gt;</li>
			</ul>
		<p class="notes">
			Located in <a class="field" href="_query_Query_interface_php.html">/query/Query.interface.php</a> (line <span class="field">33</span>)
		</p>
		
				
		<pre></pre>
	
			</div>
</div>




	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
												<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
		</div>
		<div class="info-box-body">			
			<div class="method-summary">
								
				<div class="method-definition">
											<span class="method-result">object</span>
										<a href="#execute" title="details" class="method-name">execute</a>
										()
									</div>
								
				<div class="method-definition">
											<span class="method-result">int</span>
										<a href="#getLanguage" title="details" class="method-name">getLanguage</a>
										()
									</div>
								
				<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#getPersistentQueryPath" title="details" class="method-name">getPersistentQueryPath</a>
										()
									</div>
								
				<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#getStatement" title="details" class="method-name">getStatement</a>
										()
									</div>
								
				<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#save" title="details" class="method-name">save</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$absPath</span>)
									</div>
							</div>
		</div>
	</div>		

	
	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
																<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
						
		</div>
		<div class="info-box-body">
			<A NAME='method_detail'></A>
<a name="methodexecute" id="execute"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">execute</span> (line <span class="line-number">40</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Executes this search and returns a <a href="../phpContentRepository/QueryResultIterator.html">QueryResultIterator</a>.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">object</span>
		<span class="method-name">
			execute
		</span>
				()
			</div>
	
		
		
	</div>
<a name="methodgetLanguage" id="getLanguage"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">getLanguage</span> (line <span class="line-number">64</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the language set for this query.</p>
<p class="description"><p>This will be one of the <a href="../phpContentRepository/QueryLanguage.html">QueryLanguage</a> constants returned by  <a href="../phpContentRepository/QueryManager.html#methodgetSupportedQueryLanguages">QueryManager::getSupportedQueryLanguages()</a>.</p><p>If the query was created using a mechanism outside the specification,  this method may return 0.</p></p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
				<li><span class="field">see:</span> <a href="../phpContentRepository/QueryLanguage.html">QueryLanguage</a></li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">int</span>
		<span class="method-name">
			getLanguage
		</span>
				()
			</div>
	
		
		
	</div>
<a name="methodgetPersistentQueryPath" id="getPersistentQueryPath"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">getPersistentQueryPath</span> (line <span class="line-number">74</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">If this is a persistent query (i.e., it has been saved), returns the path  of the <a href="../phpContentRepository/Node.html">Node</a> that persists it or NULL if it has not  been saved.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			getPersistentQueryPath
		</span>
				()
			</div>
	
		
		
	</div>
<a name="methodgetStatement" id="getStatement"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">getStatement</span> (line <span class="line-number">49</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the statement set for this query. Returns NULL  if no statement is currently set.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			getStatement
		</span>
				()
			</div>
	
		
		
	</div>
<a name="methodsave" id="save"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">save</span> (line <span class="line-number">96</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Creates a persistent query.</p>
<p class="description"><p>The persisted query will be created as a <a href="../phpContentRepository/Node.html">Node</a> of <a href="../phpContentRepository/NodeType.html">NodeType</a>  nt:query. This method persists the new <a href="../phpContentRepository/Node.html">Node</a>  immediately; there is no need to call <a href="../phpContentRepository/Node.html#methodsave">Node::save()</a>.</p></p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
				<li><span class="field">throws:</span> <a href="../phpContentRepository/Exceptions/ItemExistsException.html">ItemExistsException</a>    If an <a href="../phpContentRepository/Item.html">Item</a> already exists at the indicated position</li>
				<li><span class="field">throws:</span> <a href="../phpContentRepository/Exceptions/PathNotFoundException.html">PathNotFoundException</a>    If the path cannot be found</li>
				<li><span class="field">throws:</span> <a href="../phpContentRepository/Exceptions/ConstraintViolationException.html">ConstraintViolationException</a>    If creating the <a href="../phpContentRepository/Node.html">Node</a> would violate a <a href="../phpContentRepository/NodeType.html">NodeType</a> (or other    implementation specific) constraint.</li>
				<li><span class="field">throws:</span> <a href="../phpContentRepository/Exceptions/RepositoryException.html">RepositoryException</a> If another error occurs.</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			save
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$absPath</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$absPath</span><span class="var-description">: The absolute path at which to persist/save this <a href="../phpContentRepository/Query.html">Query</a>.</span>			</li>
				</ul>
		
		
	</div>
						
		</div>
	</div>


	<p class="notes" id="credit">
		Documentation generated on Fri, 31 Dec 2004 10:15:21 -0600 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0RC3</a>
	</p>
	</div></body>
</html>